/*
 * sysmo 服务器监控值类
 * Copyright (C) 2009  YuLicheng
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.sysmo.server.node.item.graphgroup.value;

import java.util.List;
import java.util.Vector;
import org.sysmo.db.DatabaseInterface;
import org.sysmo.db.DbData;
import org.sysmo.db.DbValue;
import org.sysmo.db.DbWarning;
import org.sysmo.server.node.item.Result;
import org.sysmo.server.node.item.ReceivedResult;
import org.sysmo.server.node.item.Warning;
import org.sysmo.server.util.ChildEventListener;
import org.sysmo.server.util.InstanceNotInitializedException;
import org.sysmo.server.util.TimeInterval;

/**
 * 
 * 监控值对象。监控值是监控的最小记录单位。
 * <br />
 * 
 * 使用客户端发送的监控数据经过传递最终将由监控值对象将对应的值存入数据库。
 * <br />
 *
 * 此模块不需要与客户端之间直接进行任何通讯。调用各种set类方法对此对象实例的参数进行
 * 修改后，必须显式调用{@link #sync()}方法将所有修改一次性写入数据库。
 *
 * @author YuLicheng
 */
public class Value {

    private DatabaseInterface dbInterface;
    private DbValue value;
    private ChildEventListener<Value> eventListener;

    /**
     * 监控值的统计类型枚举。统计类型用于选择数据项的表现方式。可以对已有的数据进行积
     * 分或求导运算后再绘制图表，以便查看监控值记录的累计情况或速度等。
     */
    public enum StatisticType {
        /**
         * 标量。即绘制图表时直接用原始数据。
         */
        SCALAR,
        /**
         * 累加量。即绘制图表时使用对现有数据进行积分运算后的结果。
         */
        ACCUMULATED,
        /**
         * 导数量。即绘制图表时使用对现有数据进行求导运算后的结果。
         */
        DERIVATIVE;
    };

    /**
     * 实例化数据库中已存在的监控值。
     *
     * @param eventListener 子对象事件接口。
     * @param dbInterface 数据库访问接口。
     * @param id 监控值ID。
     * @throws ValueNotExistsException 监控值ID不存在。
     */
    public Value(ChildEventListener<Value> eventListener,
            DatabaseInterface dbInterface, int id)
            throws ValueNotExistsException {
        this.eventListener = eventListener;
        this.dbInterface = dbInterface;
        this.value = null;
        try {
            this.value = dbInterface.query_ValueTable(id);
        } catch (Exception e) {
            e.printStackTrace();
        }
        if (this.value == null) {
            throw new ValueNotExistsException(id);
        }
    }

    /**
     * 创建一个新监控值。
     *
     * @param eventListener 子对象事件接口。
     * @param dbInterface 数据库接口。
     * @param name 新监控值名称。
     * @param graphID 所属图表ID。
     * @throws ValueExistsException 存在同名监控值。
     */
    public Value(ChildEventListener<Value> eventListener,
            DatabaseInterface dbInterface, String name, int graphID)
            throws ValueExistsException {
        this.eventListener = eventListener;
        this.dbInterface = dbInterface;
        //TODO: 为Value设定有意义的默认值
        this.value = new DbValue();
        value.gid = graphID;
        value.max_num = 100;
        value.min_num = 100;
        value.name = name;
        value.type = StatisticType.SCALAR.ordinal();
        //TODO: 为Value确定新对象的vid值
        value.vid = 0;
        try {
            if (dbInterface.query_ValueTable(name, graphID) == null) {
                throw new ValueExistsException(name);
            }
            dbInterface.update_ValueTable(value);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 设置监控值名称。
     * <br />
     * 
     * 调用此方法后数据库内数据并没有立即修改，在执行完本实例的所有set方法后，应调
     * 用{@link #sync()}方法将修改写入数据库。
     *
     * @param name 监控值新名称。
     * @throws ValueExistsException 若存在同名监控值则抛出此异常。
     * @see #sync()
     */
    public void setName(String name) throws ValueExistsException {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        DbValue dbvalue;
        try {
            dbvalue = dbInterface.query_ValueTable(name, value.gid);
        } catch (Exception e) {
            e.printStackTrace();
            return;
        }
        if (dbvalue != null) {
            throw new ValueExistsException(name);
        }
        value.name = name;
    }

    /**
     * 获取此监控值名称。
     *
     * @return 监控值名称。
     */
    public String getName() {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        return value.name;
    }

    /**
     * 获取此监控值ID。
     *
     * @return 监控值ID。
     */
    public int getID() {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        return value.vid;
    }

    /**
     * 设置此监控值的记录取值范围。此范围会用于图表绘制。
     * <br />
     *
     * 调用此方法后数据库内数据并没有立即修改，在执行完本实例的所有set方法后，应调用
     * {@link #sync()}方法将修改写入数据库。
     *
     * @param low 记录可能的最小值。
     * @param high 记录可能的最大值。
     * @throws IllegalArgumentException 若指定的最大值小于最小值则抛出此异常。
     * @see #sync()
     */
    public void setRange(int low, int high) throws IllegalArgumentException {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        value.min_num = low;
        value.max_num = high;
    }

    /**
     * 返回此监控值记录取值下限。
     *
     * @return 监控值记录取值下限。
     */
    public int getRangeLow() {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        return value.min_num;
    }

    /**
     * 返回此监控值记录取值上限。
     *
     * @return 监控值记录取值上限。
     */
    public int getRangeHigh() {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        return value.max_num;
    }

    /**
     * 返回此监控项的统计类型。
     *
     * @return 统计类型对象。
     * @see StatisticType
     */
    public StatisticType getStatisticType() {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        return StatisticType.values()[value.type];
    }

    /**
     * 设置此监控项的统计类型。
     * <br />
     *
     * 调用此方法后数据库内数据并没有立即修改，在执行完本实例的所有set方法后，应调用
     * {@link #sync()}方法将修改写入数据库。
     *
     * @param statisticType 新统计类型。
     * @see StatisticType
     * @see #sync()
     */
    public void setStatisticType(StatisticType statisticType) {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        value.type = statisticType.ordinal();
    }

    /**
     * 保存客户端发送的监控数据。此方法会将相应的数据存入数据库。
     * <br />
     *
     * 此方法会忽略非本图表的记录，并调用相应的监控值的saveData方法来存储。
     *
     * @param values 监控结果集合。
     */
    public void saveData(List<ReceivedResult> values) {
        for (ReceivedResult res : values) {
            if (res.getItemName().equals(value.name)) {
                Warning warning = res.getWarning();
                if (warning != null) {
                    warning.setValueID(value.vid);
                }
                res.setValueID(value.vid);
                res.saveData();
            }
        }
    }

    /**
     * 按时间获取指定层次的记录。
     *
     * @param dataRange 数据时间段。
     * @param layer 指定的记录层次，即时间粒度。具体见{@link DatabaseInterface}
     * 中的相关定义。
     * @return 指定时间段记录列表。
     */
    public List<Result> getResults(TimeInterval dataRange, int layer) {
        java.sql.Date startTime, endTime;
        startTime = DatabaseInterface.convertDate(dataRange.getStartTime());
        endTime = DatabaseInterface.convertDate(dataRange.getEndTime());
        Vector<Result> results = new Vector<Result>();
        Vector<DbData> dataSet =
                dbInterface.qurey_DataTable(value.vid, startTime, endTime, layer);
        for (DbData data : dataSet) {
            results.add(new Result(dbInterface, data));
        }
        return results;
    }

    /**
     * 获取属于此监控项的所有警告。
     *
     * @return 返回警告列表。
     */
    public List<Warning> getWarnings() {
        Vector<DbWarning> warningSet =
                dbInterface.query_WarningTable(0, 0, 0, value.vid);
        Vector<Warning> results = new Vector<Warning>();
        for (DbWarning warning : warningSet) {
            results.add(new Warning(dbInterface, warning));
        }
        return results;
    }

    /**
     * 将此对象设为无效，此方法不会从数据库删除任何数据。
     */
    public void invalid() {
        value = null;
    }

    /**
     * 从数据库删除与此对象相关的所有数据并且将当前对象设为无效。
     */
    public void remove() {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        eventListener.childRemoved(this);
        try {
            dbInterface.delete_ValueTable(value.vid);
        } catch (Exception e) {
            e.printStackTrace();
        }
        invalid();
    }

    /**
     * 此方法将此实例的元数据修改写入数据库。
     */
    public void sync() {
        if (value == null) {
            throw new InstanceNotInitializedException();
        }
        try {
            dbInterface.update_ValueTable(value);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
